DicomObjects.NetStandard Documentation
DicomObjects Namespace / DicomImage Class / Write Method / Write(Byte[],String,Object) Method

Byte Array to write image data to

Specifies the full UID of the transfer syntax with which the data is to be saved when Part 10 format is used. If omitted, the little-endian explicit VR transfer syntax is used. For details of the currently supported syntaxes, see .

The quality factor to be used. This is a generic compression quality depending on the Transfer Syntax used. This value for JPEG Baseline and JPEG Extended compression represents an integer between 0 – 100. This tells DicomObjects to set up the compressor to try to achieve the quality in percentage (higher quality value towards 100 means better quality and lower compression ratio). And for JPEG-LS Lossy and JPEG2000 Lossy compression this value is actually the desired compression ratio, i.e. if you set the quality value to 10, it tells DicomObjects to try to achieve compression ratio of 10. The actual compression ratio achieved will not be exactly the same as specified by quality value but close enough. The actual compression ratio is calculated based on the original data size and the compressed data size before it is added to “Lossy Image Compression Ratio” tag of the image. For Video compression, this value directly corresponds to the BitsPerSecond of the compressed video.




In This Topic
    Write(Byte[],String,Object) Method
    In This Topic
    Write the data to a Byte Array with specified transfer syntax and quality
    Syntax
    'Declaration
     
    
    Public Overloads Sub Write( _
       ByRef Array() As Byte, _
       ByVal TransferSyntax As String, _
       ByVal Quality As Object _
    ) 
    'Usage
     
    
    Dim instance As DicomImage
    Dim Array() As Byte
    Dim TransferSyntax As String
    Dim Quality As Object
     
    instance.Write(Array, TransferSyntax, Quality)
    public void Write( 
       out byte[] Array,
       string TransferSyntax,
       object Quality
    )
    public:
    void Write( 
       [Out] array<byte>^ Array,
       String^ TransferSyntax,
       Object^ Quality
    ) 

    Parameters

    Array

    Byte Array to write image data to

    TransferSyntax

    Specifies the full UID of the transfer syntax with which the data is to be saved when Part 10 format is used. If omitted, the little-endian explicit VR transfer syntax is used. For details of the currently supported syntaxes, see .

    Quality

    The quality factor to be used. This is a generic compression quality depending on the Transfer Syntax used. This value for JPEG Baseline and JPEG Extended compression represents an integer between 0 – 100. This tells DicomObjects to set up the compressor to try to achieve the quality in percentage (higher quality value towards 100 means better quality and lower compression ratio). And for JPEG-LS Lossy and JPEG2000 Lossy compression this value is actually the desired compression ratio, i.e. if you set the quality value to 10, it tells DicomObjects to try to achieve compression ratio of 10. The actual compression ratio achieved will not be exactly the same as specified by quality value but close enough. The actual compression ratio is calculated based on the original data size and the compressed data size before it is added to “Lossy Image Compression Ratio” tag of the image. For Video compression, this value directly corresponds to the BitsPerSecond of the compressed video.

    Remarks

    Quality is specific to the compression method being used, and is ignored for non-compressed or lossless JPEG transfer syntaxes. For Lossy JPEG, it is an integer in the range 1-100, the higher the number, the better the quality (and the larger the file) , and for JPEG 2000 lossy, it is a compression ratio. Other compression methods may use this for other purposes in the future.

    Data may be read back by the corresponding Read method.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also